GetIndString

GetIndString
Header:	TextUtils.h		Carbon status:	Supported

Loads a string from a string list ('STR#') resource into memory, given the resource ID of the string list and the index of the individual string.

void GetIndString (
    Str255 theString, 
    SInt16 strListID, 
    SInt16 index
);

Parameter descriptions

theString: On output, the Pascal string result; specifically, a copy of the string from a string list that has the resource ID provided in the strListID parameter. If the resource that you specify cannot be read or the index that you specify is out of range for the string list, GetIndString sets theString to an empty string.
strListID: The resource ID of the 'STR#' resource that contains the string list.
index: The index of the string in the list. This is a value from 1 to the number of strings in the list that is referenced by the strListID parameter.

DISCUSSION

If necessary, GetIndString reads the string list from the resource file by calling the Resource Manager function GetResource. GetIndString accesses the string specified by the index parameter and copies it into theString.

SPECIAL CONSIDERATIONS

GetIndString may move memory; your application should not call this function at interrupt time.

AVAILABILITY

Supported in Carbon. Available in Carbon 1.0.2 and later when running Mac OS 8.1 or later.